/*
 * Copyright (C) 2010-2025 Structr GmbH
 *
 * This file is part of Structr <http://structr.org>.
 *
 * Structr is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * Structr is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Structr.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.structr.docs.impl.service;

import org.structr.docs.*;

import java.util.List;

public class MailServiceDocumentable implements Documentable {

	@Override
	public DocumentableType getDocumentableType() {
		return DocumentableType.Service;
	}

	@Override
	public String getName() {
		return "MailService";
	}

	@Override
	public String getShortDescription() {
		return "A service that queries mailboxes and stores the emails in the database.";
	}

	@Override
	public String getLongDescription() {
		return """
		### Types
		`Mailbox`, `EMailMessage`
		""";
	}

	@Override
	public List<Parameter> getParameters() {
		return List.of();
	}

	@Override
	public List<Example> getExamples() {
		return List.of();
	}

	@Override
	public List<String> getNotes() {
		return List.of();
	}

	@Override
	public List<Signature> getSignatures() {
		return List.of();
	}

	@Override
	public List<Language> getLanguages() {
		return List.of();
	}

	@Override
	public List<Usage> getUsages() {
		return List.of();
	}

	@Override
	public List<Setting> getSettings() {

		return List.of(
			new Setting("mail.maxemails",          "Maximum number of (new) emails that are fetched and created in one go"),
			new Setting("mail.updateinterval",     "Update interval in milliseconds"),
			new Setting("mail.attachmentbasepath", "path in Structr's virtual filesystem where attachments are downloaded to")
		);
	}
}
